﻿//-----------------------------------------------------------------------
// <copyright file="ICamera.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Render
{
    using TileTool.Common.Math;

    /// <summary>
    /// Interface for a 2D camera.
    /// 
    /// The camera's position is the center of the screen with the half
    /// bounds giving the distance to the left / right and top / bottom
    /// of the scene that is visible.
    /// </summary>
    public interface ICamera
    {
        #region Properties

        /// <summary>
        /// Gets or sets the camera's position.
        /// </summary>
        Vector2D Position
        {
            get;
            set;
        }

        /// <summary>
        /// Gets the rect that represents the bounds of the camera.
        /// </summary>
        Rect2D Rect
        {
            get;
        }

        /// <summary>
        /// Gets the camera's matrix.
        /// </summary>
        Matrix2D Matrix
        {
            get;
        }

        /// <summary>
        /// Gets the canvas we are in.
        /// </summary>
        ICanvas Canvas
        {
            get;
        }

        #endregion
    }
}
